Skip to content

Warn against DebeziumIO not resilient to worker crash or restart#37076

Merged
Abacn merged 1 commit intoapache:masterfrom
Abacn:warn-debezium
Dec 12, 2025
Merged

Warn against DebeziumIO not resilient to worker crash or restart#37076
Abacn merged 1 commit intoapache:masterfrom
Abacn:warn-debezium

Conversation

@Abacn
Copy link
Contributor

@Abacn Abacn commented Dec 10, 2025 •
edited
Loading

See #28248

ideally we should fix that.

DebeziumIO is implemented to use low-level APIs (SourceConnector/SourceTask) to interact with Debezium. It requires manual handling of offset tracking. It has an in memory offset tracking as a static final Map member (KafkaSourceConsumerFn.restrictionTrackers) that is not saved on worker restart.

Another problem is that it saves offset in restriction tracker (OffsetHolder), while the restriction itself is not serializable (Map<String, Object>) and persumably not saved to runner. The trySplit implementation is also need to be revisited.

Please add a meaningful description for your change here

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Dec 10, 2025

Summary of Changes

Hello @Abacn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a critical limitation in the DebeziumIO connector by adding a clear warning in its documentation. The change aims to inform users that the connector is currently experimental and lacks resilience to worker crashes or restarts, which can result in reprocessing all data from the source. This ensures users are aware of potential data consistency issues and the need for careful consideration when deploying DebeziumIO in production environments.

Highlights

  • DebeziumIO Warning: Added a warning to the Javadoc of DebeziumIO indicating its experimental status and a known issue where it does not preserve offsets on worker crash or restart, leading to data re-retrieval from the beginning.
  • Issue Reference: Included a reference to Issue Handling the restart with apache beam debezium application #28248 for users to find more detailed information about the resilience problem with DebeziumIO.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@Abacn
Copy link
Contributor Author

Abacn commented Dec 10, 2025

R: @shunping

@github-actions
Copy link
Contributor

github-actions bot commented Dec 10, 2025

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

@Abacn Abacn merged commit f9bccb8 into apache:master Dec 12, 2025
17 checks passed
@Abacn Abacn deleted the warn-debezium branch December 12, 2025 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shunping shunping shunping approved these changes

Assignees

No one assigned

Labels

io java

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Abacn @shunping